Objects Reference

flyEngine::get_next_stock_object

Prototype

bsp_object *get_next_stock_object(bsp_object *o,int type=0)

Parameters

Parameter Type Description
o bsp_object * object pointer
type int object type modifier

Return Value

Returns the object next to the specified one or NULL if at end of list.

Remarks

This function is used to walk through the stock object linked list. When called with o=NULL it will return the first object in the stock objects linked list. When called with o<>NULL it will return the object following the object o in the stock objects linked list. If the type parameter is <>0, only objects with that type id are returned.

Usually used like this:

bsp_object *obj=0;
while( obj=flyengine->get_next_stock_object(obj) )
{
  // do somethig with object obj
}